/**
 * Copyright(c) 2014 Xunton Solutions
 *
 * History:
 *   15-12-8 上午10:51 Created by dwzhang
 */
package com.jade.modules.message.store;

import java.util.Date;
import java.util.List;
import java.util.Map;

import com.jade.framework.base.criterion.Criteria;
import com.jade.framework.base.util.PagingList;

/**
 * 消息记录存储器。
 *
 * @author <a href="mailto:dwzhang@xunton.com">dwzhang</a> 
 * @version 1.0 15-12-8 上午10:51
 */
public interface MessageStore
{
    /**
     * 新增消息记录。
     *
     * @param message 消息记录
     * @throws StoreException
     */
    public void add(MessageRecord message)
            throws StoreException;

    /**
     * 修改消息记录状态。
     *
     * @param id 消息标识
     * @param status 消息状态
     * @throws StoreException
     */
    public void updateStatus(long id, int status)
            throws StoreException;

    /**
     * 删除消息。
     *
     * @param ids 消息标识
     */
    public void remove(long... ids);

    /**
     * 删除一个用户接收到某一分组的所有消息。
     *
     * @param receiverType 接收者类型
     * @param receiver 接收者
     * @param category 消息分类
     * @return 删除数量
     */
    public int remove(String receiverType, String receiver, String category);

    /**
     * 根据标识获取消息。
     *
     * @param id 消息标识
     * @return 消息记录
     */
    public MessageRecord get(long id);

    /**
     * 分页查询消息记录。
     *
     * @param criteria 查询条件
     * @return 消息列表
     */
    public PagingList<MessageRecord> query(Criteria criteria);

    /**
     * 查询消息记录。
     *
     * @param criteria 查询条件
     * @return 消息列表
     */
    public List<MessageRecord> list(Criteria criteria);

    /**
     * 获取用户从某一个时刻以后的新消息数量。
     *
     * @param receiverType 接收者类型
     * @param receiver 接收者
     * @param time 设定时间
     * @return 新消息数量
     */
    public long getNewMsgCount(String receiverType, String receiver, Date time);

    /**
     * 获取用户某一类消息从某一个时刻以后的新消息数量。
     *
     * @param receiverType 接收者类型
     * @param receiver 接收者
     * @param time 设定时间
     * @param category 消息分类
     * @return 新消息数量
     */
    public long getNewMsgCount(String category, String receiverType, String receiver, Date time);

    /**
     *  获取用户从一时刻以后各个分类的新消息数量。
     *
     * @param receiverType 接收者类型
     * @param receiver 接收者
     * @param time 设定时间
     * @return 各个分类的新消息数量
     */
    public Map<String, Long> getNewMsgCountByCategory(String receiverType, String receiver, Date time);
}
